Skip to content

docs: use brew for pre-commit install#4

Merged
Jason-Adam merged 1 commit intomainfrom
docs/brew-install-pre-commit
Mar 28, 2026
Merged

docs: use brew for pre-commit install#4
Jason-Adam merged 1 commit intomainfrom
docs/brew-install-pre-commit

Conversation

@Jason-Adam
Copy link
Copy Markdown
Owner

@Jason-Adam Jason-Adam commented Mar 28, 2026

Summary

  • Replace pip install pre-commit with brew install pre-commit in the README development section

Test plan

  • Verify README renders correctly on GitHub

🤖 Generated with Claude Code

Homebrew is the preferred package manager for this project's dev setup.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings March 28, 2026 08:49
@Jason-Adam Jason-Adam self-assigned this Mar 28, 2026
@Jason-Adam Jason-Adam merged commit 31e218b into main Mar 28, 2026
3 checks passed
@Jason-Adam Jason-Adam deleted the docs/brew-install-pre-commit branch March 28, 2026 08:50
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the developer onboarding instructions to change how contributors install pre-commit before setting up git hooks.

Changes:

  • Replace pip install pre-commit with brew install pre-commit in the README development section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines 29 to 31
# Install pre-commit hooks
pip install pre-commit
brew install pre-commit
pre-commit install
Copy link

Copilot AI Mar 28, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

brew install pre-commit is macOS/Homebrew-specific and will break setup for contributors on Linux/Windows (or macOS without Homebrew). Consider documenting multiple install options (e.g., Homebrew or pipx/pip install --user pre-commit) or linking to the official pre-commit installation docs so the README remains platform-agnostic.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants